package com.py.custom.common.web.enums;

/**
 * description： 返回结构枚举类；统一定义
 *
 * @author pengyou
 * @version 1.0.0
 * @date 2021/10/17
 */
public enum ResponseEnums {

    // 失败
    FAIL(-1, "失败", ""),

    // 成功
    SUCCESS(0, "成功", ""),

    // 业务异常定义，使用code，可以修改msg，把错误信息放入errorMsg中用于排查错误
    BIZ_ERROR(1, "业务异常", ""),

    // 系统异常
    SYSTEM_ERROR(2, "服务未知异常", ""),

    // 参数异常
    PARAM_ERROR(3, "请求参数异常", ""),

    // 空指针
    NULL_POINT_ERROR(4, "空指针异常", ""),

    // sql执行异常，把错误信息放入errorMsg中用于排查错误
    SQL_ERROR(5, "sql 执行异常", ""),

    RETURN_VIOLATION_ERROR(6, "返回结果校验异常", ""),
    ;

    /**
     * 返回信息状态码
     */
    int code;

    /**
     * 使用方提示信息
     */
    String msg;

    /**
     * 后端排查问题，提示信息
     */
    String errorMsg;

    ResponseEnums(int code, String msg, String errorMsg) {
        this.code = code;
        this.msg = msg;
        this.errorMsg = errorMsg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    public String getErrorMsg() {
        return errorMsg;
    }
}
